Created onboarding document for excalidraw project#15
Created onboarding document for excalidraw project#15paulsamtsov wants to merge 1 commit intokoldovsky:mainfrom
Conversation
📝 WalkthroughWalkthroughA new onboarding documentation file is added to guide new contributors through the Excalidraw project. The document outlines the product overview, key features, technology stack, monorepo architecture, development prerequisites, and local setup instructions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
Onboarding_document.md (1)
39-39: Clarify the directory reference.The phrase "primary directory of interest is
excalidraw/" could be ambiguous for new contributors. Consider clarifying whether this refers to the repository root or a specific subdirectory within the repository structure.📝 Suggested clarification
If
excalidraw/is the repository root:-The codebase is organized as a monorepo containing multiple packages and applications. The primary directory of interest is `excalidraw/`, which houses the core project: +The codebase is organized as a monorepo containing multiple packages and applications at the repository root:If it's a subdirectory, be more explicit:
-The codebase is organized as a monorepo containing multiple packages and applications. The primary directory of interest is `excalidraw/`, which houses the core project: +The codebase is organized as a monorepo containing multiple packages and applications. The core project resides in the `excalidraw/` subdirectory:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@Onboarding_document.md` at line 39, Clarify the ambiguous phrase "primary directory of interest is `excalidraw/`" by explicitly stating whether `excalidraw/` is the repository root or a subdirectory; update the sentence to read either "the repository root (excalidraw/)" or "the subdirectory `excalidraw/` within the repo" and, if it's a subdirectory, add a brief parent-folder context (e.g., "located under `<parent-folder>/excalidraw/`") so new contributors immediately know where to look; ensure the change is applied to the sentence containing `excalidraw/` in the onboarding doc.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@Onboarding_document.md`:
- Line 11: Replace the incorrect unhyphenated compound adjective "hand-drawn
like diagrams" with the hyphenated form "hand-drawn-like diagrams" in the
sentence "It is built for creating beautiful hand-drawn like diagrams,
wireframes, architectural visualizations, brainstorming sessions, or whatever
visual representations you need." to correct hyphenation.
- Line 59: Replace the ambiguous instruction "Navigate to the `excalidraw`
folder (or the root if the monorepo handles it top-level)" with a clear path:
explicitly tell contributors to cd into the package (e.g.,
"packages/excalidraw") and only use the repository root when this project lives
at the top level; locate the exact sentence in Onboarding_document.md and change
it to something like: "Navigate to the excalidraw package at packages/excalidraw
(or to the repository root only if this project is top-level in your monorepo)."
- Line 8: Update the sentence in Onboarding_document.md that reads "Excalidraw
is an open-source, virtual, hand-drawn style whiteboard application." to
hyphenate the compound adjective so it reads "hand-drawn-style" when modifying
"whiteboard application"; locate the exact sentence and replace "hand-drawn
style" with "hand-drawn-style" to correct the hyphenation.
- Line 63: Replace the non-standard command "yarn clean-install" in the
onboarding note with standard Yarn alternatives; update the note to suggest
either removing node_modules and reinstalling (e.g., "rm -rf node_modules &&
yarn install" or using a cross-platform tool like "rimraf node_modules && yarn
install") or using "yarn install --force" to refresh dependencies, and ensure
the note mentions which option is cross-platform if you include rimraf.
---
Nitpick comments:
In `@Onboarding_document.md`:
- Line 39: Clarify the ambiguous phrase "primary directory of interest is
`excalidraw/`" by explicitly stating whether `excalidraw/` is the repository
root or a subdirectory; update the sentence to read either "the repository root
(excalidraw/)" or "the subdirectory `excalidraw/` within the repo" and, if it's
a subdirectory, add a brief parent-folder context (e.g., "located under
`<parent-folder>/excalidraw/`") so new contributors immediately know where to
look; ensure the change is applied to the sentence containing `excalidraw/` in
the onboarding doc.
| ## 1. General Description | ||
|
|
||
| **What is it?** | ||
| Excalidraw is an open-source, virtual, hand-drawn style whiteboard application. It is highly collaborative and end-to-end encrypted. |
There was a problem hiding this comment.
Fix hyphenation in compound adjective.
When "hand-drawn style" is used as a compound adjective modifying "whiteboard application," it should be hyphenated as "hand-drawn-style" per standard English grammar rules.
✏️ Proposed fix
-Excalidraw is an open-source, virtual, hand-drawn style whiteboard application. It is highly collaborative and end-to-end encrypted.
+Excalidraw is an open-source, virtual, hand-drawn-style whiteboard application. It is highly collaborative and end-to-end encrypted.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Excalidraw is an open-source, virtual, hand-drawn style whiteboard application. It is highly collaborative and end-to-end encrypted. | |
| Excalidraw is an open-source, virtual, hand-drawn-style whiteboard application. It is highly collaborative and end-to-end encrypted. |
🧰 Tools
🪛 LanguageTool
[grammar] ~8-~8: Use a hyphen to join words.
Context: ...w is an open-source, virtual, hand-drawn style whiteboard application. It is high...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@Onboarding_document.md` at line 8, Update the sentence in
Onboarding_document.md that reads "Excalidraw is an open-source, virtual,
hand-drawn style whiteboard application." to hyphenate the compound adjective so
it reads "hand-drawn-style" when modifying "whiteboard application"; locate the
exact sentence and replace "hand-drawn style" with "hand-drawn-style" to correct
the hyphenation.
| Excalidraw is an open-source, virtual, hand-drawn style whiteboard application. It is highly collaborative and end-to-end encrypted. | ||
|
|
||
| **What is it for?** | ||
| It is built for creating beautiful hand-drawn like diagrams, wireframes, architectural visualizations, brainstorming sessions, or whatever visual representations you need. |
There was a problem hiding this comment.
Fix hyphenation in compound adjective.
The phrase "hand-drawn like diagrams" should use "hand-drawn-like" with a hyphen when functioning as a compound adjective.
✏️ Proposed fix
-It is built for creating beautiful hand-drawn like diagrams, wireframes, architectural visualizations, brainstorming sessions, or whatever visual representations you need.
+It is built for creating beautiful hand-drawn-like diagrams, wireframes, architectural visualizations, brainstorming sessions, or whatever visual representations you need.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| It is built for creating beautiful hand-drawn like diagrams, wireframes, architectural visualizations, brainstorming sessions, or whatever visual representations you need. | |
| It is built for creating beautiful hand-drawn-like diagrams, wireframes, architectural visualizations, brainstorming sessions, or whatever visual representations you need. |
🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: Use a hyphen to join words.
Context: ... built for creating beautiful hand-drawn like diagrams, wireframes, architectural...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@Onboarding_document.md` at line 11, Replace the incorrect unhyphenated
compound adjective "hand-drawn like diagrams" with the hyphenated form
"hand-drawn-like diagrams" in the sentence "It is built for creating beautiful
hand-drawn like diagrams, wireframes, architectural visualizations,
brainstorming sessions, or whatever visual representations you need." to correct
hyphenation.
| Follow these steps to set up and start the application on your local machine: | ||
|
|
||
| 1. **Install Dependencies** | ||
| Navigate to the `excalidraw` folder (or the root if the monorepo handles it top-level) and run: |
There was a problem hiding this comment.
Clarify the installation directory.
The instruction "Navigate to the excalidraw folder (or the root if the monorepo handles it top-level)" is confusing and could lead new contributors to the wrong location. Provide a clear, unambiguous path.
📝 Suggested clarification
- Navigate to the `excalidraw` folder (or the root if the monorepo handles it top-level) and run:
+ Navigate to the repository root and run:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Navigate to the `excalidraw` folder (or the root if the monorepo handles it top-level) and run: | |
| Navigate to the repository root and run: |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@Onboarding_document.md` at line 59, Replace the ambiguous instruction
"Navigate to the `excalidraw` folder (or the root if the monorepo handles it
top-level)" with a clear path: explicitly tell contributors to cd into the
package (e.g., "packages/excalidraw") and only use the repository root when this
project lives at the top level; locate the exact sentence in
Onboarding_document.md and change it to something like: "Navigate to the
excalidraw package at packages/excalidraw (or to the repository root only if
this project is top-level in your monorepo)."
| ```bash | ||
| yarn install | ||
| ``` | ||
| *(Note: If you encounter dependency issues, you can run `yarn clean-install` to wipe `node_modules` and start fresh).* |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if clean-install script exists in package.json files
fd -t f 'package.json' -x jq -r 'select(.scripts["clean-install"] != null) | {file: input_filename, script: .scripts["clean-install"]}'Repository: koldovsky/is-01-docs
Length of output: 46
🏁 Script executed:
#!/bin/bash
# First, find all package.json files
fd -t f 'package.json' | head -20 | while read file; do
echo "=== $file ==="
cat "$file" | jq '.scripts | keys' 2>/dev/null || echo "Failed to parse $file"
doneRepository: koldovsky/is-01-docs
Length of output: 46
🏁 Script executed:
#!/bin/bash
# Simple check for package.json
ls -la package.json 2>/dev/null || echo "No package.json in root"
# Check if it exists anywhere
find . -name "package.json" -type f 2>/dev/null | head -10
# If found, show the scripts section
if [ -f "package.json" ]; then
echo "=== Scripts in package.json ==="
jq '.scripts // {}' package.json
fiRepository: koldovsky/is-01-docs
Length of output: 87
🏁 Script executed:
#!/bin/bash
# List files in root directory
ls -la | head -30
# Check git ls-files for project structure overview
git ls-files | head -30Repository: koldovsky/is-01-docs
Length of output: 557
Update the documentation to use standard Yarn commands.
The yarn clean-install command is not a standard Yarn v1 (classic) command and is not defined as a custom script in this project. Update the note to use standard commands:
Suggested change
- *(Note: If you encounter dependency issues, you can run `yarn clean-install` to wipe `node_modules` and start fresh).*
+ *(Note: If you encounter dependency issues, you can remove `node_modules` and `yarn.lock`, then run `yarn install` to start fresh).*📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| *(Note: If you encounter dependency issues, you can run `yarn clean-install` to wipe `node_modules` and start fresh).* | |
| *(Note: If you encounter dependency issues, you can remove `node_modules` and `yarn.lock`, then run `yarn install` to start fresh).* |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@Onboarding_document.md` at line 63, Replace the non-standard command "yarn
clean-install" in the onboarding note with standard Yarn alternatives; update
the note to suggest either removing node_modules and reinstalling (e.g., "rm -rf
node_modules && yarn install" or using a cross-platform tool like "rimraf
node_modules && yarn install") or using "yarn install --force" to refresh
dependencies, and ensure the note mentions which option is cross-platform if you
include rimraf.
1 participant
Summary by CodeRabbit